// --------------------------------------------------------------------------------------------------------------------
// <copyright file="StatusGenerics.cs" company="Open Trader">
//   Copyright (c) David Denis (david.denis@systemathics.com)
// </copyright>
// <summary>
//   |  Open Trader - The Open Source Systematic Trading Platform
//   |
//   |  This program is free software: you can redistribute it and/or modify
//   |  it under the terms of the GNU General Public License as published by
//   |  the Free Software Foundation, either version 2 of the License, or
//   |  (at your option) any later version.
//   |
//   |  This program is distributed in the hope that it will be useful,
//   |  but WITHOUT ANY WARRANTY; without even the implied warranty of
//   |  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//   |  GNU General Public License for more details.
//   |
//   |  You should have received a copy of the GNU General Public License
//   |  along with this program.  If not, see http://www.gnu.org/licenses
//   |
//   |  Up to date informations about Open Trader can be found at :
//   |    http://opentrader.org
//   |    http://opentrader.codeplex.com
//   |
//   |  For professional services, please visit us at :
//   |    http://www.systemathics.com
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace Org.OpenTrader.Framework
{
    #region Usings

    using System;

    #endregion

    /// <summary>
    /// The status.
    /// </summary>
    /// <typeparam name="T">
    /// </typeparam>
    [Serializable]
    public class Status<T> : Status
    {
        #region Constructors and Destructors

        /// <summary>
        /// Initializes a new instance of the <see cref="Status{T}"/> class.
        /// </summary>
        /// <param name="identity">
        /// The Identity.
        /// </param>
        /// <param name="success">
        /// The success.
        /// </param>
        /// <param name="detailedMessage">
        /// The detailedMessage.
        /// </param>
        public Status(Identity identity, bool success, string detailedMessage)
            : base(identity, success, detailedMessage)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="Status{T}"/> class.
        /// </summary>
        /// <param name="identity">
        /// The Identity.
        /// </param>
        /// <param name="success">
        /// The success.
        /// </param>
        /// <param name="detailedMessage">
        /// The detailedMessage.
        /// </param>
        /// <param name="nestedObject">
        /// The nested object.
        /// </param>
        public Status(Identity identity, bool success, string detailedMessage, T nestedObject)
            : base(identity, success, detailedMessage)
        {
            this.NestedObject = nestedObject;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="Status{T}"/> class.
        /// </summary>
        /// <param name="identity">
        /// The Identity.
        /// </param>
        /// <param name="success">
        /// The success.
        /// </param>
        /// <param name="detailedMessage">
        /// The detailedMessage.
        /// </param>
        /// <param name="nestedStatus">
        /// The nested status.
        /// </param>
        /// <param name="nestedObject">
        /// The nested object.
        /// </param>
        public Status(Identity identity, bool success, string detailedMessage, Status nestedStatus, T nestedObject)
            : base(identity, success, detailedMessage, nestedStatus)
        {
            this.NestedObject = nestedObject;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="Status{T}"/> class.
        /// </summary>
        /// <param name="identity">
        /// The Identity.
        /// </param>
        /// <param name="success">
        /// The success.
        /// </param>
        /// <param name="detailedMessage">
        /// The detailedMessage.
        /// </param>
        /// <param name="nestedStatus">
        /// The nested status.
        /// </param>
        public Status(Identity identity, bool success, string detailedMessage, Status nestedStatus)
            : base(identity, success, detailedMessage, nestedStatus)
        {
        }

        #endregion

        #region Properties

        /// <summary>
        /// Gets NestedObject.
        /// </summary>
        public T NestedObject { get; private set; }

        #endregion

        #region Operators

        /// <summary>
        /// Operator ton convert success to bool
        /// </summary>
        /// <param name="s"></param>
        /// <returns></returns>
        public static implicit operator bool(Status<T> s)
        {
            return s.Sucess;
        }

        #endregion
    }
}